Function Reference

_IEFrameGetObjByName

Returns an object reference to a Frame or iFrame by name.

#include <IE.au3>
_IEFrameGetObjByName ( ByRef $o_object, $s_name )

 

Parameters

$o_object Object variable of an InternetExplorer.Application, Window or Frame object
$s_name Name of the Frame you wish to match

 

Return Value

Success: Returns an object variable pointing to the Window object in a Frame, @EXTENDED = Frame count
Failure: Returns 0 and sets @ERROR
@Error: 0 ($_IEStatus_Success) = No Error
3 ($_IEStatus_InvalidDataType) = Invalid Data Type
4 ($_IEStatus_InvalidObjectType) = Invalid Object Type
7 ($_IEStatus_NoMatch) = No Match
@Extended: Contains invalid parameter number

 

Remarks

The object returned by this function is a window object which allows access to the document contained within. You may also want to access the frame or iframe tag and its properties - to do this, use _IETagNameGetCollection.

 

Related

_IEFrameGetCollection

 

Example


; *******************************************************
; Example 1 - Open iFrame example, get a reference to the iFrame
;               with a name of "iFrameTwo" and replace its body HTML
; *******************************************************
;
#include <IE.au3>
$oIE = _IE_Example ("iframe")
$oFrame = _IEFrameGetObjByName ($oIE, "iFrameTwo")
_IEBodyWriteHTML ($oFrame, "Hello <b>iFrame!</b>")
_IELoadWait ($oFrame)